<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>phpDocumentor » \Application_Model_RolesUsers</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">phpDocumentor</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/fr.html"><i class="icon-folder-open"></i> fr</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">477</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">1</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#addMembre" title="addMembre :: "><span class="description">addMembre()
        </span><pre>addMembre()</pre></a></li>
<li class="method public "><a href="#getAdmins" title="getAdmins :: Get all the admins of a group, including the general admins."><span class="description">Get all the admins of a group, including the general admins.</span><pre>getAdmins()</pre></a></li>
<li class="method public "><a href="#getAdminsNotGeneral" title="getAdminsNotGeneral :: Get all the admins of a group, excluding the general admins."><span class="description">Get all the admins of a group, excluding the general admins.</span><pre>getAdminsNotGeneral()</pre></a></li>
<li class="method public "><a href="#getDbTable" title="getDbTable :: Get the table of the data base."><span class="description">Get the table of the data base.</span><pre>getDbTable()</pre></a></li>
<li class="method public "><a href="#getMembres" title="getMembres :: "><span class="description">getMembres()
        </span><pre>getMembres()</pre></a></li>
<li class="method public "><a href="#getVendeurs" title="getVendeurs :: "><span class="description">getVendeurs()
        </span><pre>getVendeurs()</pre></a></li>
<li class="method public "><a href="#isAdminGeneral" title="isAdminGeneral :: "><span class="description">isAdminGeneral()
        </span><pre>isAdminGeneral()</pre></a></li>
<li class="method public "><a href="#isMembre" title="isMembre :: To know if a given user is member of a
given group."><span class="description">To know if a given user is member of a
given group.</span><pre>isMembre()</pre></a></li>
<li class="method public "><a href="#removeAdmin" title="removeAdmin :: "><span class="description">removeAdmin()
        </span><pre>removeAdmin()</pre></a></li>
<li class="method public "><a href="#removeVendeur" title="removeVendeur :: "><span class="description">removeVendeur()
        </span><pre>removeVendeur()</pre></a></li>
<li class="method public "><a href="#setDbTable" title="setDbTable :: Set the table name for Application_Model_Groupe"><span class="description">Set the table name for Application_Model_Groupe</span><pre>setDbTable()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24_dbTable" title="$_dbTable :: "><span class="description">$_dbTable</span><pre>$_dbTable</pre></a></li>
<li class="property protected "><a href="#%24_dbTableClass" title="$_dbTableClass :: "><span class="description">$_dbTableClass</span><pre>$_dbTableClass</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants</li>
<li class="constant  "><a href="#ADMIN_ID" title="ADMIN_ID :: "><span class="description">ADMIN_ID</span><pre>ADMIN_ID</pre></a></li>
<li class="constant  "><a href="#VENDEUR_ID" title="VENDEUR_ID :: "><span class="description">VENDEUR_ID</span><pre>VENDEUR_ID</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CApplication_Model_RolesUsers" id="\Application_Model_RolesUsers"></a><div href="../classes/Application_Model_RolesUsers.html" class="element class">
<p class="short_description">This class represent an association between a user
and a role in a group.</p>
<div class="details">
<p class="long_description"><p>The corresponding table in the database is "cb_roles_users",
represented by Application_Model_RolesUsersTable.</p></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/fr.ec-lyon.aeecl.codebar.application.model.rolesusers.html">fr.ec-lyon.aeecl.codebar.application.model</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>rolesusers</td>
</tr>
<tr>
<th>author</th>
<td><a href="">Théo Chamley</a></td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="addMembre" id="addMembre"></a><div class="element clickable method public addMembre" data-toggle="collapse" data-target=".addMembre .collapse">
<h2>addMembre()
        </h2>
<pre>addMembre($id_role, $login, $id_groupe) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id_role</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$login</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$id_groupe</h4>
<code></code>
</div>
</div></div>
</div>
<a name="getAdmins" id="getAdmins"></a><div class="element clickable method public getAdmins" data-toggle="collapse" data-target=".getAdmins .collapse">
<h2>Get all the admins of a group, including the general admins.</h2>
<pre>getAdmins(array $id_groupe) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id_groupe</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="getAdminsNotGeneral" id="getAdminsNotGeneral"></a><div class="element clickable method public getAdminsNotGeneral" data-toggle="collapse" data-target=".getAdminsNotGeneral .collapse">
<h2>Get all the admins of a group, excluding the general admins.</h2>
<pre>getAdminsNotGeneral(array $id_groupe) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id_groupe</h4>
<code>array</code>
</div>
</div></div>
</div>
<a name="getDbTable" id="getDbTable"></a><div class="element clickable method public getDbTable" data-toggle="collapse" data-target=".getDbTable .collapse">
<h2>Get the table of the data base.</h2>
<pre>getDbTable() : \the</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>\the</code>table of the database.</div>
</div></div>
</div>
<a name="getMembres" id="getMembres"></a><div class="element clickable method public getMembres" data-toggle="collapse" data-target=".getMembres .collapse">
<h2>getMembres()
        </h2>
<pre>getMembres($id_groupe) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id_groupe</h4>
<code></code>
</div>
</div></div>
</div>
<a name="getVendeurs" id="getVendeurs"></a><div class="element clickable method public getVendeurs" data-toggle="collapse" data-target=".getVendeurs .collapse">
<h2>getVendeurs()
        </h2>
<pre>getVendeurs($id_groupe) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id_groupe</h4>
<code></code>
</div>
</div></div>
</div>
<a name="isAdminGeneral" id="isAdminGeneral"></a><div class="element clickable method public isAdminGeneral" data-toggle="collapse" data-target=".isAdminGeneral .collapse">
<h2>isAdminGeneral()
        </h2>
<pre>isAdminGeneral($login) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$login</h4>
<code></code>
</div>
</div></div>
</div>
<a name="isMembre" id="isMembre"></a><div class="element clickable method public isMembre" data-toggle="collapse" data-target=".isMembre .collapse">
<h2>To know if a given user is member of a
given group.</h2>
<pre>isMembre(<a href="../classes/Application_Model_User.html">\Application_Model_User</a> $user, <a href="../classes/Application_Model_Groupe.html">\Application_Model_Groupe</a> $group) : true</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$user</h4>
<code><a href="../classes/Application_Model_User.html">\Application_Model_User</a></code>
</div>
<div class="subelement argument">
<h4>$group</h4>
<code><a href="../classes/Application_Model_Groupe.html">\Application_Model_Groupe</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>true</code>if the $user is a member of the $group.</div>
</div></div>
</div>
<a name="removeAdmin" id="removeAdmin"></a><div class="element clickable method public removeAdmin" data-toggle="collapse" data-target=".removeAdmin .collapse">
<h2>removeAdmin()
        </h2>
<pre>removeAdmin($id_groupe, $login) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id_groupe</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$login</h4>
<code></code>
</div>
</div></div>
</div>
<a name="removeVendeur" id="removeVendeur"></a><div class="element clickable method public removeVendeur" data-toggle="collapse" data-target=".removeVendeur .collapse">
<h2>removeVendeur()
        </h2>
<pre>removeVendeur($id_groupe, $login) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id_groupe</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$login</h4>
<code></code>
</div>
</div></div>
</div>
<a name="setDbTable" id="setDbTable"></a><div class="element clickable method public setDbTable" data-toggle="collapse" data-target=".setDbTable .collapse">
<h2>Set the table name for Application_Model_Groupe</h2>
<pre>setDbTable(String $dbTable) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$dbTable</h4>
<code>String</code><p>the name of the class representing the table</p></div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="http://php.net/manual/en/class.exception.php">\Exception</a></code></th>
<td></td>
</tr></table>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24_dbTable" id="$_dbTable"> </a><div class="element clickable property protected $_dbTable" data-toggle="collapse" data-target=".$_dbTable .collapse">
<h2>$_dbTable</h2>
<pre>$_dbTable </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24_dbTableClass" id="$_dbTableClass"> </a><div class="element clickable property protected $_dbTableClass" data-toggle="collapse" data-target=".$_dbTableClass .collapse">
<h2>$_dbTableClass</h2>
<pre>$_dbTableClass </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a name="ADMIN_ID" id="ADMIN_ID"> </a><div class="element clickable constant  ADMIN_ID" data-toggle="collapse" data-target=".ADMIN_ID .collapse">
<h2>ADMIN_ID</h2>
<pre>ADMIN_ID </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="VENDEUR_ID" id="VENDEUR_ID"> </a><div class="element clickable constant  VENDEUR_ID" data-toggle="collapse" data-target=".VENDEUR_ID .collapse">
<h2>VENDEUR_ID</h2>
<pre>VENDEUR_ID </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
            generated on 2012-06-06T16:55:24+02:00.<br></footer></div>
</div>
</body>
</html>
